MapLibre Native for Android/com.mapbox.mapboxsdk.maps/UiSettings

UiSettings

class UiSettings

Settings for the user interface of a MapboxMap. To obtain this interface, call getUiSettings().

Functions

Link copied to clipboard
open fun areAllGesturesEnabled(): Boolean
Retrieves the current status of whether all gestures are enabled.
Link copied to clipboard
open fun getAttributionGravity(): Int
Returns the gravity value of the logo
Link copied to clipboard
@Px
open fun getAttributionMarginBottom(): Int
Returns the bottom side margin of the logo in pixels.
Link copied to clipboard
@Px
open fun getAttributionMarginLeft(): Int
Returns the left side margin of the attribution view in pixels.
Link copied to clipboard
@Px
open fun getAttributionMarginRight(): Int
Returns the right side margin of the attribution view in pixels.
Link copied to clipboard
@Px
open fun getAttributionMarginTop(): Int
Returns the top side margin of the attribution view in pixels.
Link copied to clipboard
open fun getCompassGravity(): Int
Returns the gravity value of the CompassView
Link copied to clipboard
@Nullable
open fun getCompassImage(): Drawable
Get the current configured CompassView image.
Link copied to clipboard
@Px
open fun getCompassMarginBottom(): Int
Returns the bottom side margin of CompassView in pixels.
Link copied to clipboard
@Px
open fun getCompassMarginLeft(): Int
Returns the left side margin of CompassView in pixels.
Link copied to clipboard
@Px
open fun getCompassMarginRight(): Int
Returns the right side margin of CompassView in pixels.
Link copied to clipboard
@Px
open fun getCompassMarginTop(): Int
Returns the top side margin of CompassView in pixels.
Link copied to clipboard
@Nullable
open fun getFocalPoint(): PointF
Returns the gesture focal point
Link copied to clipboard
open fun getHeight(): Float
Returns the measured height of the MapView
Link copied to clipboard
open fun getLogoGravity(): Int
Returns the gravity value of the logo
Link copied to clipboard
@Px
open fun getLogoMarginBottom(): Int
Returns the bottom side margin of the logo in pixels.
Link copied to clipboard
@Px
open fun getLogoMarginLeft(): Int
Returns the left side margin of the logo in pixels.
Link copied to clipboard
@Px
open fun getLogoMarginRight(): Int
Returns the right side margin of the logo in pixels.
Link copied to clipboard
@Px
open fun getLogoMarginTop(): Int
Returns the top side margin of the logo in pixels.
Link copied to clipboard
open fun getWidth(): Float
Returns the measured width of the MapView
Link copied to clipboard
open fun invalidate()
Invalidates the ViewSettings instances shown on top of the MapView
Link copied to clipboard
open fun isAttributionEnabled(): Boolean
Returns whether the attribution is enabled.
Link copied to clipboard
open fun isCompassEnabled(): Boolean
Returns whether the compass is enabled.
Link copied to clipboard
open fun isCompassFadeWhenFacingNorth(): Boolean
Returns whether the compass performs a fading animation out when facing north.
Link copied to clipboard
open fun isDeselectMarkersOnTap(): Boolean
Gets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
Link copied to clipboard
open fun isDisableRotateWhenScaling(): Boolean
Returns whether rotation gesture detector is disabled when scale is detected first.
Link copied to clipboard
open fun isDoubleTapGesturesEnabled(): Boolean
Returns whether the user may zoom the map with a double tap.
Link copied to clipboard
open fun isFlingVelocityAnimationEnabled(): Boolean
Returns whether fling velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun isHorizontalScrollGesturesEnabled(): Boolean
Returns whether the user may scroll horizontally around the map.
Link copied to clipboard
open fun isIncreaseRotateThresholdWhenScaling(): Boolean
Returns whether rotation threshold should be increase whenever scale is detected.
Link copied to clipboard
open fun isIncreaseScaleThresholdWhenRotating(): Boolean
Returns whether scale threshold should be increase whenever rotation is detected.
Link copied to clipboard
open fun isLogoEnabled(): Boolean
Returns whether the logo is enabled.
Link copied to clipboard
open fun isQuickZoomGesturesEnabled(): Boolean
Returns whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.
Link copied to clipboard
open fun isRotateGesturesEnabled(): Boolean
Returns whether the user may rotate the map.
Link copied to clipboard
open fun isRotateVelocityAnimationEnabled(): Boolean
Returns whether rotate velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun isScaleVelocityAnimationEnabled(): Boolean
Returns whether scale velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun isScrollGesturesEnabled(): Boolean
Returns whether the user may scroll around the map.
Link copied to clipboard
open fun isTiltGesturesEnabled(): Boolean
Returns whether the user may tilt the map.
Link copied to clipboard
open fun isZoomGesturesEnabled(): Boolean
Returns whether the user may zoom the map.
Link copied to clipboard
open fun setAllGesturesEnabled(enabled: Boolean)
Sets the preference for whether all gestures should be enabled or disabled.
Link copied to clipboard
open fun setAllVelocityAnimationsEnabled(allVelocityAnimationsEnabled: Boolean)
Set whether all velocity animations should execute after users finishes a gesture.
Link copied to clipboard
open fun setAttributionEnabled(enabled: Boolean)
Enables or disables the attribution.
Link copied to clipboard
open fun setAttributionGravity(gravity: Int)
Sets the gravity of the attribution.
Link copied to clipboard
open fun setAttributionMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)
Sets the margins of the attribution view in pixels.
Link copied to clipboard
open fun setAttributionTintColor(@ColorInt tintColor: Int)
Sets the tint of the attribution view.
Link copied to clipboard
open fun setCompassEnabled(compassEnabled: Boolean)
Enables or disables the compass.
Link copied to clipboard
open fun setCompassFadeFacingNorth(compassFadeFacingNorth: Boolean)
Enables or disables fading of the compass when facing north.
Link copied to clipboard
@UiThread
open fun setCompassGravity(gravity: Int)
Sets the gravity of the compass view.
Link copied to clipboard
open fun setCompassImage(@NonNull compass: Drawable)
Specifies the CompassView image.
Link copied to clipboard
@UiThread
open fun setCompassMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)
Sets the margins of the compass view in pixels.
Link copied to clipboard
open fun setDeselectMarkersOnTap(deselectMarkersOnTap: Boolean)
Sets whether the markers are automatically deselected (and therefore, their infowindows closed) when a map tap is detected.
Link copied to clipboard
open fun setDisableRotateWhenScaling(disableRotateWhenScaling: Boolean)
Set whether rotation gesture detector should be disabled when scale is detected first.
Link copied to clipboard
open fun setDoubleTapGesturesEnabled(doubleTapGesturesEnabled: Boolean)
Changes whether the user may zoom the map with a double tap.
Link copied to clipboard
open fun setFlingVelocityAnimationEnabled(flingVelocityAnimationEnabled: Boolean)
Set whether fling velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun setFocalPoint(@Nullable focalPoint: PointF)
Sets the focal point used as center for a gesture
Link copied to clipboard
open fun setHorizontalScrollGesturesEnabled(horizontalScrollGesturesEnabled: Boolean)
Changes whether the user may scroll horizontally around the map.
Link copied to clipboard
open fun setIncreaseRotateThresholdWhenScaling(increaseRotateThresholdWhenScaling: Boolean)
Set whether rotation threshold should be increase whenever scale is detected.
Link copied to clipboard
open fun setIncreaseScaleThresholdWhenRotating(increaseScaleThresholdWhenRotating: Boolean)
set whether scale threshold should be increase whenever rotation is detected.
Link copied to clipboard
open fun setLogoEnabled(enabled: Boolean)
Enables or disables the Mapbox logo.
Link copied to clipboard
open fun setLogoGravity(gravity: Int)
Sets the gravity of the logo view.
Link copied to clipboard
open fun setLogoMargins(@Px left: Int, @Px top: Int, @Px right: Int, @Px bottom: Int)
Sets the margins of the logo view in pixels.
Link copied to clipboard
open fun setQuickZoomGesturesEnabled(quickZoomGesturesEnabled: Boolean)
Changes whether the user may zoom the map by tapping twice, holding and moving the pointer up and down.
Link copied to clipboard
open fun setRotateGesturesEnabled(rotateGesturesEnabled: Boolean)
Changes whether the user may rotate the map.
Link copied to clipboard
open fun setRotateVelocityAnimationEnabled(rotateVelocityAnimationEnabled: Boolean)
Set whether rotate velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun setScaleVelocityAnimationEnabled(scaleVelocityAnimationEnabled: Boolean)
Set whether scale velocity animation should execute after users finishes a gesture.
Link copied to clipboard
open fun setScrollGesturesEnabled(scrollGesturesEnabled: Boolean)
Changes whether the user may scroll around the map.
Link copied to clipboard
open fun setTiltGesturesEnabled(tiltGesturesEnabled: Boolean)
Changes whether the user may tilt the map.
Link copied to clipboard
open fun setZoomGesturesEnabled(zoomGesturesEnabled: Boolean)
Changes whether the user may zoom the map.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var flingThreshold: Long
Link copied to clipboard
open var zoomRate: Float